Skip to content

doc(PdfViewer): add OnLoaded event callback sample code #6166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 6, 2025
Merged

doc(PdfViewer): add OnLoaded event callback sample code #6166

merged 1 commit into from
Jun 6, 2025

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jun 6, 2025 •
edited by sourcery-ai bot
Loading

Link issues

fixes #6165

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Add sample usage of OnLoaded and NotSupportCallback callbacks to the PdfViewer demonstration and simplify the accompanying code by removing outdated reader logic

New Features:

  • Demonstrate OnLoaded and NotSupportCallback event callbacks in the PdfViewer sample component

Enhancements:

  • Streamline the PdfViewer sample by removing legacy AdvancedPdfReader properties and methods and injecting ToastService for callback handling

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Jun 6, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 6, 2025 •
edited
Loading

Reviewer's Guide

Refactors the PdfViewer sample to illustrate OnLoaded and NotSupportCallback event usage by injecting ToastService, cleaning up obsolete sample code, and updating markup and localization entries.

Sequence Diagram: PdfViewer NotSupportCallback Event Interaction

sequenceDiagram
    participant PdfViewerComponent as PdfViewer Component
    participant PdfViewersPage as PdfViewers Page
    participant ToastSvc as ToastService

    PdfViewerComponent-->>PdfViewerComponent: Browser/feature not supported check
    PdfViewerComponent->>PdfViewersPage: NotSupportCallback event
    activate PdfViewersPage
    PdfViewersPage->>PdfViewersPage: NotSupportCallback() handler called
    PdfViewersPage->>ToastSvc: Error("PdfViewer", "PdfViewerToastNotSupportContent")
    activate ToastSvc
    ToastSvc-->>ToastSvc: Display error message
    deactivate ToastSvc
    deactivate PdfViewersPage
Loading

File-Level Changes

Change Details Files
Inject and utilize ToastService to handle PdfViewer events
  • Add [Inject] ToastService property
  • Implement OnLoaded event handler
  • Implement NotSupportCallback event handler
 src/BootstrapBlazor.Server/Components/Samples/PdfViewers.razor.cs
Remove outdated PdfViewer sample logic
  • Delete StreamMode, ReadOnly, Watermark and related properties
  • Remove zoom, page mode, search, navigation helper methods
  • Remove legacy GetAttributes definitions
 src/BootstrapBlazor.Server/Components/Samples/PdfViewers.razor.cs
Update sample markup to wire up new callbacks
  • Add OnLoaded attribute to
  • Add NotSupportCallback attribute to
src/BootstrapBlazor.Server/Components/Samples/PdfViewers.razor
Extend localization resources for toast messages
  • Add success message key for OnLoaded event
  • Add error message key for unsupported callback
 src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json

Assessment against linked issues

Issue Objective Addressed Explanation
#6165 Add sample code demonstrating the usage of the OnLoaded event callback for the PdfViewer component. ✅

Possibly linked issues

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added this to the 9.7.0 milestone Jun 6, 2025
@ArgoZhang ArgoZhang merged commit d139e8c into main Jun 6, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the feat-pdf branch June 6, 2025 03:14
@codecov
Copy link

codecov bot commented Jun 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.99%. Comparing base (c333024) to head (fe2d056).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #6166   +/-   ##
=======================================
  Coverage   99.99%   99.99%           
=======================================
  Files         704      704           
  Lines       31099    31099           
  Branches     4395     4395           
=======================================
  Hits        31098    31098           
  Partials        1        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sourcery-ai[bot]
sourcery-ai bot approved these changes Jun 6, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] approved these changes

Assignees

@ArgoZhang ArgoZhang

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

v9.7.0

Development

Successfully merging this pull request may close these issues.

doc(PdfViewer): add OnLoaded event callback sample code

2 participants

@ArgoZhang